68.2 解决自动配置问题

Spring Boot自动配置总是尝试尽最大努力去做正确的事,但有时候会失败并且很难说出失败原因。

在每个Spring Boot ApplicationContext中都存在一个相当有用的ConditionEvaluationReport。如果开启DEBUG日志输出,你将会看到它。如果你使用spring-boot-actuator,则会有一个autoconfig的端点,它将以JSON形式渲染该报告。你还可以使用它调试应用程序,并能查看Spring Boot运行时都添加了哪些特性(及哪些没添加)。

通过查看源码和javadoc可以获取更多问题的答案,以下是一些经验:

  • 查找名为*AutoConfiguration的类并阅读源码,特别是@Conditional*注解,这可以帮你找出它们启用哪些特性及何时启用。 将--debug添加到命令行或添加系统属性-Ddebug可以在控制台查看日志,该日志会记录你的应用中所有自动配置的决策。在运行Actuator的app中,通过查看autoconfig端点(/autoconfig或等效的JMX)可以获取相同信息。
  • 查找@ConfigurationProperties的类(比如ServerProperties)并看下有哪些可用的外部配置选项。@ConfigurationProperties类有一个用于充当外部配置前缀的name属性,因此ServerPropertiesprefix="server",它的配置属性有server.portserver.address等。在运行Actuator的应用中可以查看configprops端点。
  • 查看RelaxedPropertyResolver明确地将配置从Environment暴露出去,它经常会使用前缀。
  • 查看@Value注解,它直接绑定到Environment。相比RelaxedPropertyResolver,这种方式稍微缺乏灵活性,但它也允许松散的绑定,特别是OS环境变量(所以CAPITALS_AND_UNDERSCORESperiod.separated的同义词)。
  • 查看@ConditionalOnExpression注解,它根据SpEL表达式的结果来开启或关闭特性,通常使用解析自Environment的占位符进行计算。